docs: Split conversation schema for list vs detail endpoints#396
Merged
docs: Split conversation schema for list vs detail endpoints#396
Conversation
Add a new `conversation_list_item` schema (without `conversation_parts`)
for list/search endpoints, keeping the original `conversation` schema
completely unchanged. This ensures `GET /conversations/{id}` is not
affected while list/search responses no longer misleadingly document
`conversation_parts`.
Addresses internal ticket 215473350697203.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
marcmlc
force-pushed
the
marcmeillac/split-conversation-list-schema
branch
from
fc036ba to
2c8b1f8
Compare
levindixon
approved these changes
Mar 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why?
The Search/List Conversations endpoint response schema shows
conversation_partsas a possible field, but this object is never returned from list/search endpoints — only fromGET /conversations/{id}. This causes confusion for developers integrating with the API (internal ticket 215473350697203).How?
Splits the
conversationschema intoconversation_list_item(used by list/search endpoints, withoutconversation_parts) andconversation(inherits fromconversation_list_itemviaallOf, addsconversation_parts). This makes the distinction structurally explicit in the spec rather than relying on a prose caveat.Generated with Claude Code